Skip to main content

Data Management (Admin)

This guide outlines essential backend data management tasks for administrators maintaining a MAXRES Construct instance. It covers database inspection, manual backups, and migration techniques.

Overview​

MAXRES Construct uses MongoDB as its primary database. Admin users may need to inspect data, manage plugins, back up systems, or migrate content between environments. These actions require elevated privileges and direct server access.

Requirements​

  • Administrator access to the MAXRES Construct server
  • Familiarity with MongoDB, file system structures, and service control
  • Experience with system-level backup and recovery processes
  • MongoDB Compass

MongoDB & Compass​

Database Usage​

MAXRES Construct stores all user, course, and system data in a MongoDB database.

  • MongoDB Compass is the preferred GUI for exploring the database
  • Allows inspection of collections and documents (records)

Key Collections​

Collection NameDescription
configsSystem-wide configuration settings
courseassetsAsset metadata for lessons
coursebuildsBuild records of exported packages
coursestructuresStructured content of lessons
pluginsPlugin metadata and settings
sessionsActive user session data
tagsAsset and course tagging
tenantsTenant-specific configuration
usersUser accounts and role assignments
caution

Direct database edits should only be performed by experienced administrators. Improper changes can corrupt platform data or functionality.

Backups & Archives​

Backups ensure data protection and allow for recovery in case of failure.

Manual Backup Process​

  1. Stop Services: Stop Mongod, Redis, and the Author application service.
  2. Copy Database Folder: Back up the full MongoDB directory (e.g., C:\data\AuthorDB).
  3. Copy Plugins Folder: Back up the AuthorPlugins directory (e.g., C:\author_db_backups\<date>\AuthorPlugins).
  4. Restart Services: Start Mongod, Redis, and Author.

Manual Restore Process​

  1. Stop Services: Stop Mongod, Redis, and Author.
  2. Delete Current Data: Remove existing database and plugin folders.
  3. Restore from Backup: Copy the backed-up AuthorDB and plugin folders (components, extensions, menu, theme) into their original paths.
  4. Restart Services: Restart all services.
warning

This is a high-risk, manual process. Always test your backup and restore strategy in a safe environment before using it in production. Use automation where possible.

Data Migration Between Instances​

MAXRES Construct supports two approaches for transferring data from one instance to another.

Method 1: Course Export/Import​

  1. Export individual lessons from Instance A using the Export source feature.
  2. Import each .zip package into Instance B using the Import Source feature.

Pros​

  • Granular control over transferred content
  • Non-destructive to existing data

Cons​

  • Time-consuming for large numbers of lessons
  • Does not include user accounts or system settings
  • Target instance must have compatible plugins installed

Method 2: Full Backup/Restore​

  1. Back up all data from Instance A using the manual backup method.
  2. Restore the data onto Instance B, overwriting its contents.

Pros​

  • Migrates everything: lessons, users, plugins, and configurations

Cons​

  • Overwrites all existing data on Instance B
  • Requires downtime and careful execution
  • Must ensure server compatibility between instances

By using appropriate backup and migration strategies, administrators can ensure data integrity, minimize downtime, and maintain consistency across MAXRES Construct environments.